home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / wildcat / plant11.zip / PLANTER.DOC < prev    next >
Text File  |  1992-11-18  |  18KB  |  458 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.          ┌──────────────────────────────────────────────────┐
  13.          │                PLANTER  ver 1.10                 │
  14.          │            For WILDCAT! 3.x Systems              │
  15.          │           (C) 1992 - LIFE DESIGN LTD.            │
  16.          │             - All Rights Reserved -              │
  17.          └──────────────────────────────────────────────────┘
  18.  
  19.                  Technical Support and the latest versions!
  20.  
  21.                         Sun Surf & Serenity
  22.  
  23.                        (708) 453-1321  2400
  24.                        (708) 453-6630  9600 V.32/V42bis
  25.  
  26.  
  27.   Planter v1.10 -  A Sysop utility for Wildcat BBS systems
  28. ────────────────────────────────────────────────────────────────────
  29.  
  30.         - DESCRIPTION -
  31.       
  32.   Planter began as a little utility to pass any door name or number and 
  33.   the time it was accessed to your ACTIVITY.xxx. Planter can now add 
  34.   just about anything you would want to the ACTIVITY.xxx; from DOS Hooks 
  35.   to Mail Events.
  36.  
  37.   Planter will notify you of any error it encounters in the %WCxxx% 
  38.   environment and create a error report "planter.err" in the directory 
  39.   it was run from.
  40.  
  41.   Planter is semi-intelligent in that if run in a multi-node 
  42.   environment, it will PLANT the appropriate information in the correct 
  43.   activity.xxx
  44.  
  45.   Planter is transparent to the remote user, and is quick enough 
  46.   that it runs virtually undetected, save for a brief notice on the 
  47.   local screen.
  48.  
  49.   Planter runs in Desqview and Windows environments without conflict 
  50.   or special configuration.
  51.  
  52.   Planter is SHAREWARE! Please support the shareware experience.
  53.  
  54.   Planter is Copyrighted, with ALL RIGHTS RESERVED by Chris Koziol of 
  55.   Life Design Ltd.
  56.  
  57.  
  58.     Planter v1.10 -  A Sysop utility for Wildcat BBS systems 
  59.   ────────────────────────────────────────────────────────────────────
  60.  
  61.     - Installation -
  62.  
  63.   1.)   Copy PLANTER.EXE and PLANTER.CFG to any directory or 
  64.         subdirectory in your path.
  65.  
  66.         i.e. PATH=C:\;C:\DOS;D:\WC30;...etc
  67.  
  68.         PLANTER.EXE & PLANTER.CFG may reside in any directory that is in 
  69.         your path. While this is not absolutely necessary, it makes life 
  70.         so much easier.
  71.  
  72.   2.)   Edit the included PLANTER.CFG file that is included.
  73.  
  74.         line1: Sysop's Name           ex:  Chris Koziol
  75.         line2: BBS Name               ex:  Sun Surf & Serenity
  76.         line3: Registration No.       ex:  ?????????
  77.  
  78.         PLANTER.CFG must be present for Planter v1.10 to run!!!
  79.         PLANTER.CFG should contain 3 lines with a normal carriage return 
  80.         line feed at the end of each line.
  81.  
  82.      ** line3, should be BLANK if you have not yet registered PLANTER.
  83.  
  84.   3.)   Place the following statements in your CATx.BAT or batch file 
  85.         that starts up your BBS.
  86.  
  87.             SET WCHOME=C:\WC30  <<--or wherever your wildcat.exe, 
  88.                                     tomcat.exe, activity.xxx reside
  89.  
  90.             SET WCNODEID=X      <<--should correspond to catX.bat.
  91.                                     EX. cat3.bat should contain:
  92.                                             SET WCNODEID=3          
  93.                                     EX. cat13.bat should contain:
  94.                                             SET WCNODEID=13
  95.                                     EX. cat213.bat should contain:
  96.                                             SET WCNODEID=213
  97.  
  98.             SET PLANT=D:\WCUTIL <<--should reflect the directory or
  99.                                     subdirectory where you placed the
  100.                                     PLANTER files.
  101.  
  102.         *NOTE*    X can be one to three digits in length.
  103.  
  104.                   !! DO NOT PREFIX "X" WITH LEADING "0"'s  !!
  105.  
  106.     Planter v1.10 will check to see if the environment variables have 
  107.     been set. It will also check if the X is between one and three 
  108.     digits. It WILL NOT check for the existence of the directories 
  109.     nor for the "correctness" of node numbering. Please enter the 
  110.     required information carefully.
  111.  
  112.     If for any reason PLANTER does not find everything in order, the 
  113.     program will notify you of the error by placing a "plant.err" in 
  114.     the directory it was ran from with a brief description of the error 
  115.     encountered. It will also alert you locally by briefly displaying an 
  116.     error message to the local screen. Planter will then terminate and 
  117.     your door will run as normal.
  118.  
  119.   Planter v1.10 -  A Sysop utility for Wildcat BBS systems
  120. ────────────────────────────────────────────────────────────────────
  121.  
  122.     - Running Planter v1.10 -
  123.  
  124.     Running PLANTER is very simple:
  125.  
  126.                 PLANTER [switch] [name]
  127.  
  128.  
  129.         EX.  cd\door\pegjump
  130.              PLANTER /D PEG JUMP      <<-- case is not important
  131.              pegjump pegjump.cnf           capped only for emphasis
  132.              cd\wc30
  133.  
  134.     Planter may also be run from within a batch file that is called 
  135.     from another batch file:
  136.  
  137.         EX.  cd\door\pegjump
  138.              CALL STATS.BAT /D PEG JUMP
  139.              pegjump pegjump.cnf
  140.              cd\wc30
  141.  
  142.  STATS.BAT = 
  143.              cd\door               <<-- changed to \door since my stats
  144.              stats  %2 %3 %4 %5         program must run from there.
  145.              PLANTER %1 %2 %3 %4 %5     PLANTER may run from any dir.
  146.  
  147.     "%1 %2 %3 %4 %5...etc" are needed to pass the switch and name to 
  148.     PLANTER when it is run from within a batch file that is called 
  149.     from another batch file:
  150.  
  151.   EX.     planter /D AVATARS OF SCREAMING STEAL
  152.                   %1   %2    %3    %4      %5
  153.  
  154.   *NOTE* Planter will accept only one "switch" and any "name" of up to 
  155.          eight words, for a total of nine arguments passed.
  156.  
  157.  
  158.     - The Switches -
  159.  
  160.  
  161.   Switch  PLANTED in ACTIVITY.xxx           Purpose
  162. ────────────────────────────────────────────────────────────────────
  163.     /D      Door Accessed: [name]    Used in DOORx.BAT
  164.     /M      Mail Event: [name]       Used in any batch file to denote 
  165.                                      mail runs, tossing, etc.
  166.  *  /B      Batch File: [name]       Can be used for ANY batch file.
  167.  *  /C      Commenting: [name]       Used to comment any process
  168.  *  /E      BBS Event: [name]        Used in EVENT.BAT to denote 
  169.                                      maintenance, resets, etc.
  170.  *  /I      Idle Screen: [name]      Used for Batches run from the Idle 
  171.                                      Screen.
  172.  *  /H      DOS Hook: [name]         Used in MAIN/MSG/FILEx.BAT/RUN
  173.  
  174.  
  175.  * = REGISTERED VERSION ONLY 
  176.  
  177.  
  178.   Planter v1.10 -  A Sysop utility for Wildcat BBS systems
  179. ────────────────────────────────────────────────────────────────────
  180.  
  181.         - Example Uses -
  182.  
  183.   ────────────────────────────────────────────────────────────────────
  184.   /D [name] --  Can be used in DOORx.BAT or in conjunction with a Door 
  185.                 Manager.
  186.  
  187.         EX.  cd\door\pegjump
  188.              PLANTER /D PEG JUMP      <<-- can come before or after
  189.              pegjump pegjump.cnf           the commands to run the door.
  190.              cd\wc30
  191.  
  192.                 Planter may also be run from within a batch file that is 
  193.                 called from another batch file:
  194.  
  195.         EX.  cd\door\pegjump
  196.              CALL STATS.BAT /D PEG JUMP
  197.              pegjump pegjump.cnf
  198.              cd\wc30
  199.  
  200.     STATS.BAT = 
  201.              cd\door               <<-- changed to \door since my 
  202.              stats  %2 %3 %4 %5         stats program must run
  203.              PLANTER %1 %2 %3 %4 %5     from there. PLANTER may 
  204.                                         run from any dir.
  205.  
  206.         "%1 %2 %3 %4 %5...etc" are needed to pass the switch and name to 
  207.         PLANTER when it is run from within a batch file that is called 
  208.         from another batch file:
  209.  
  210.         EX.     planter /D AVATARS OF SCREAMING STEAL
  211.                         %1   %2    %3    %4      %5
  212.  
  213.   OUTPUT:
  214.  
  215.   HH:MM √ Door Accessed: PEG JUMP
  216.  
  217.   ────────────────────────────────────────────────────────────────────
  218.   /H [name] --  Used in MAIN/MSG/FILEx.BAT/RUN, the DOS Hooks that are 
  219.                 provided by MSI.
  220.  
  221.         EX. cd\wc30\wildcall
  222.             PLANTER /H CALLBACK VERIFIER                
  223.             wildcall wildcall.cfg
  224.         cd\wc30
  225.  
  226.   OUTPUT:
  227.  
  228.   HH:MM √ DOS Hook: CALLBACK VERIFIER
  229.  
  230.  
  231.   Planter v1.10 -  A Sysop utility for Wildcat BBS systems
  232. ────────────────────────────────────────────────────────────────────
  233.  
  234.   /E [name] -- Used with any batch file that is used to run a BBS event.
  235.  
  236.         EX. NIGHTLY.BAT=
  237.             cd\wcutil
  238.             PLANTER /E NIGHTLY MAINTENANCE STARTED
  239.             call tscan.bat
  240.             call logs.bat
  241.             call pack.bat
  242.             PLANTER /E NIGHTLY MAINTENANCE FINISHED
  243.   OUTPUT:
  244. -------------------------------------------------------------------------------
  245. HH:MM √ BBS Event: NIGHTLY MAINTENANCE STARTED                       MM/DD/YY
  246. -------------------------------------------------------------------------------
  247. HH:MM √ BBS Event: NIGHTLY MAINTENANCE FINISHED                      MM/DD/YY
  248.  
  249.   ────────────────────────────────────────────────────────────────────
  250.   /C [name] -- Used with ANY batch file, for commenting ACTIVITY.xxx
  251.  
  252.         This is useful if you wish to comment different actions taking 
  253.         place in events. For instance take the preceding example of the
  254.         nightly maintenance batch file; you could in effect:
  255.  
  256.         EX. NIGHTLY.BAT=
  257.             cd\wcutil
  258.             PLANTER /E NIGHTLY MAINTENANCE STARTED
  259.             PLANTER /C TRANSCAN PROCESSING...
  260.             call tscan.bat
  261.             PLANTER /C SORTING AND TRIMMING LOGS...
  262.             call logs.bat
  263.             PLANTER /C STORING LOGS IN E:\BBSLOGS...
  264.             call pack.bat
  265.             PLANTER /E NIGHTLY MAINTENANCE FINISHED
  266. OUTPUT:
  267. -------------------------------------------------------------------------------
  268. 23:50 √ BBS Event: NIGHTLY MAINTENANCE STARTED                      11/17/92
  269. 23:50 √ Commenting: TRANSCAN PROCESSING...
  270. 23:52 √ Commenting: SORTING AND TRIMMING LOGS...
  271. 23:56 √ Commenting: STORING LOGS IN E:\BBSLOGS...
  272. -------------------------------------------------------------------------------
  273. 23:58 √ BBS Event: NIGHTLY MAINTENANCE FINISHED                     11/17/92
  274.  
  275.     ALTERNATELY you could pass the parameters to the batch files called 
  276.     from within NIGHTLY.BAT as in:
  277.  
  278.         EX. NIGHTLY.BAT=
  279.             cd\wcutil
  280.             PLANTER /E NIGHTLY MAINTENANCE STARTED
  281.             call tscan.bat /C TRANSCAN PROCESSING...
  282.             call logs.bat /C SORTING AND TRIMMING LOGS...
  283.             call pack.bat /C STORING LOGS IN E:\BBSLOGS...
  284.             PLANTER /E NIGHTLY MAINTENANCE FINISHED
  285.  
  286.     And in each batch file that is "called" include as the first line:
  287.  
  288.             PLANTER %1 %2 %3 %4 %5 %6 ... etc.
  289.  
  290.     The resulting OUTPUT would be the same.
  291.  
  292.   Planter v1.10 -  A Sysop utility for Wildcat BBS systems
  293. ────────────────────────────────────────────────────────────────────
  294.  
  295.   /M [name] -- Used in the batch file that performs your "Mailruns" to 
  296.                other systems.
  297.  
  298.         EX. MSIMAIL.BAT=
  299.                 PLANTER /M MSI MAILRUN STARTED
  300.                 if exist c:\mail\mustang.rep goto mail_out
  301.                 cd\wc30
  302.                 tnet export mustang
  303.                 :mail_out
  304.                 cd\robo
  305.                 robocomm /AMSI-MAIL /R /P
  306.                 if exist c:\mail\1mustang.rep del c:\mail\1mustang.rep
  307.                 cd\wc30
  308.                 if exist c:\mail\mustang.qwk goto mail_in
  309.                 PLANTER /C MSI MAILRUN *FAILED*
  310.                 goto end
  311.                 :mail_in
  312.                 tnet import mustang
  313.                 del c:\mail\mustang.qwk
  314.                 :end            
  315.                 PLANTER /M MSI MAILRUN FINISHED
  316.  
  317.   OUTPUT: (if transfer successful)
  318. -------------------------------------------------------------------------------
  319. 02:30 √ Mail Event: MSI MAILRUN STARTED                             11/17/92
  320. -------------------------------------------------------------------------------
  321. 02:37 √ Mail Event: MSI MAILRUN FINISHED                            11/17/92
  322.  
  323.   OUTPUT: (if unsuccessful)
  324. -------------------------------------------------------------------------------
  325. 02:30 √ Mail Event: MSI MAILRUN STARTED                             11/17/92
  326. 02:37 √ Commenting: MSI MAILRUN *FAILED*
  327. -------------------------------------------------------------------------------
  328. 02:37 √ Mail Event: MSI MAILRUN FINISHED                            11/17/92
  329.  
  330.     As you can see from this last example, by controlling batchfile flow 
  331.     and using the /C switch, you can also comment in results of any 
  332.     process.
  333.  
  334. ────────────────────────────────────────────────────────────────────
  335.   /B [name] -- Used in ANY batch file that you want noted to the 
  336.                ACTIVITY.xxx log
  337.  
  338.  
  339.         EX. MYBAT.BAT=
  340.                 cd\wcutil
  341.                 PLANTER /B CALLER ID
  342.                 callerid callerid.cfg
  343.                 cd\wc30
  344. OUTPUT:
  345.  
  346. 23:52 √ Batch File: CALLER ID
  347.  
  348.  
  349.   Planter v1.10 -  A Sysop utility for Wildcat BBS systems
  350. ────────────────────────────────────────────────────────────────────
  351.  
  352.   /I [name] -- Used for commenting ACTIVITY.xxx with the batch files 
  353.                that are run from the Idle Screen.
  354.  
  355.             EX. PRO.BAT=
  356.                     cd\wc30
  357.                     PLANTER /I WCPRO STATS GENERATED
  358.                     wcpro
  359.                     
  360.  
  361.   OUTPUT:
  362. -------------------------------------------------------------------------------
  363. 02:37 √ Idle Screen: WCPRO STATS GENERATED                          11/17/92
  364.  
  365. ────────────────────────────────────────────────────────────────────
  366.  
  367.         - About the Output -
  368.  
  369.   To see PLANTER's typical output, view the SAMPLE.TXT that is included 
  370.   in this package.
  371.  
  372.   You may have noticed in the previous examples that some of the PLANTED 
  373.   information looks different for different switches. Indeed it is! 
  374.   PLANTER strives to be as compatible as possible to the myriad of 
  375.   activity log scanners, trimmers, packers that are currently available. 
  376.   PLANTER has been tested with a good number of these different 
  377.   utilities and has performed flawlessly. But as always the may be a few 
  378.   that it just will not work with, giving flawed logs. If this should 
  379.   happen, just drop me a note at any of the resources listed at the end 
  380.   of this document and I will see what I can do. 
  381.  
  382.   
  383.   Disclaimer
  384.  
  385.   Life Design Ltd. hereby disclaims all warranties relating to 
  386.   this product, whether express or implied, including without 
  387.   limitation any implied warranties of merchantability or fitness 
  388.   for a particular purpose. Life Design Ltd. cannot and will not 
  389.   be liable for any special, incidental, consequential, indirect or 
  390.   similar damages due to loss of data or any other reason, even if 
  391.   Life Design Ltd. or an authorized Life Design Ltd. agent has 
  392.   been advised of the possibility of such damages.  In no event 
  393.   shall the liability for any damages ever exceed the price paid for 
  394.   the license to use software, regardless of the form and/or extent 
  395.   of the claim.  The user of this program bears all risk as to the 
  396.   quality and performance of the software.
  397.  
  398.  
  399.   Planter v1.10 -  A Sysop utility for Wildcat BBS systems
  400. ────────────────────────────────────────────────────────────────────
  401.   Copyright
  402.  
  403.   Regardless of the method of marketing used, Planter v1.10 is NOT in 
  404.   the "Public Domain".  It is copyrighted by Chris Koziol and Life 
  405.   Design Ltd. 
  406.  
  407.   License
  408.  
  409.   Planter v1.10 is a SHAREWARE product.  As such, it is made available 
  410.   to the general computing public and anyone that may find it 
  411.   useful. Unlimited use of the Unregistered Demo is granted, although I 
  412.   strongly encourage registration for the full version. You may 
  413.   distribute the Unregistered Demo version of Planter v1.10 in its 
  414.   original form with original documentation.
  415.  
  416.   Registration
  417.  
  418.   As a SHAREWARE product, registration of Planter v1.10 is requested.
  419.   The cost is $10.00, which entitles free support, and any and all 
  420.   future upgrades. See REGISTER.TXT for further information.
  421.  
  422.   Please send any cash, comments or criticism to Chris Koziol to:
  423.  
  424.                                 Life Design Ltd.
  425.                                 c/o Chris Koziol
  426.                                 2310 N. Harlem Ave.
  427.                                 Elmwood Park , IL 60635
  428.  
  429.   Technical Support
  430.  
  431.   If you have any compatibility problems with PLANTER and any activity 
  432.   log scanner, trimmer, packer you should contact me at the resources 
  433.   listed below.
  434.  
  435.   Also enclose a copy of your ACTIVITY.xxx (pre- scan/trim/packed) and a 
  436.   second copy of your ACTIVITY.xxx (post- scan/trim/packed), the name 
  437.   and version number(!) of the utility that PLANTER is conflicting with, 
  438.   and a brief description of the problem you are experiencing. 
  439.  
  440.   Comments and suggestions about Planter v1.10 are welcome, as well as 
  441.   any comments or suggestions that you may have in terms of additional 
  442.   utilities you would like to see written.
  443.  
  444.   You may reach me at:
  445.  
  446.   Sun Surf & Serenity
  447.  
  448.   [708] 453-1321  2400
  449.   [708] 453-6630  9600 V.32
  450.  
  451.   Log on as: "PLANTER USER SUPPORT"
  452.   for immediate access.
  453.  
  454.   NETMAIL at:           Or drop a note in:
  455.                         WILDCAT or OFF-TOPIC Echo of MSI SupportNet.
  456.   Fidonet  1:115/113    SHAREWARE Echo on Fidonet
  457.   RealNet 54:6214/1     SYSOP HELP Echo on Realnet
  458.